Use BlurEffect2D to apply a Gaussian blur post-processing effect to 2D nodes. More...

#include <kanzi/core.ui/effect/blur_effect2d.hpp>

Inheritance diagram for kanzi::BlurEffect2D:

Public Types
enum	Quality { Quality::Low, Quality::Normal, Quality::High, Quality::Count }
	Defines the visual quality levels of the blur effect. More...

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
bool	getMasked () const
	Gets the value of MaskedProperty. More...

Quality	getQuality () const
	Gets the value of QualityProperty. More...

float	getRadius () const
	Gets the value of RadiusProperty. More...

void	setMasked (bool value)
	Sets the value of MaskedProperty. More...

void	setQuality (Quality value)
	Sets the value of QualityProperty. More...

void	setRadius (float value)
	Sets the value of RadiusProperty. More...

Public Member Functions inherited from kanzi::NodeEffect2D
NodeEffectRenderer2DUniquePtr	createRenderer ()
	Creates a renderer instance. More...

unsigned int	getEffectPaddingChangeCounter () const
	Gets the effect quad change counter. More...

Vector4	getEffectQuadPadding () const
	Gets the effect quad padding. More...

Vector2	getEffectQuadPaddingOffset () const
	Gets the effect quad offset relative relative to the top-left corner of the node. More...

Vector2	getEffectQuadPaddingSize () const
	Gets the effect quad padding size. More...

NodeEffectRenderer2D *	getRendererInstance () const
	Gets a pointer to NodeEffectRenderer2D instance or null pointer if none exists. More...

bool	isAlphaRequired () const
	Indicates whether the effect requires alpha channel for the result. More...

bool	isRenderingRequired ()
	Indicates whether the effect requires rendering. More...

void	unregisterEffectRenderer (NodeEffectRenderer2D *effectRenderer)
	Unregister effect renderer. More...

	~NodeEffect2D ()

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

const string &	getName () const
	Gets the resource name. More...

const string &	getUrl () const
	Gets the resource URL. More...

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...

void	setUrl (string_view url)
	Sets the resource URL. More...

	~Resource () override
	Destructor. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	applyObjectStyles ()
	Apply all styles for an object node. More...

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers. More...

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type. More...

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers. More...

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers. More...

virtual	~PropertyObject ()

Static Public Member Functions
static BlurEffect2DSharedPtr	create (Domain *domain, string_view name)
	Creates a blur effect. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Attributes
static PropertyType< bool >	MaskedProperty
	Sets whether to blur only pixels with non-zero alpha values. More...

static PropertyType< Quality >	QualityProperty
	Sets the visual quality of the blur effect. More...

static PropertyType< float >	RadiusProperty
	Sets the amount of blur by defining the radius of the circular area of pixels that blend into each other. More...

Protected Member Functions
	BlurEffect2D (Domain *domain, string_view name)
	Constructor. More...

NodeEffectRenderer2DUniquePtr	createRendererOverride () override
	NodeEffect2D::createRendererOverride implementation. More...

void	initializeRendererOverride () override
	NodeEffect2D::initializeRendererOverride implementation. More...

bool	isRenderingRequiredOverride () override
	NodeEffect2D::isRenderingRequiredOverride() implementation. More...

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	PropertyObject::onPropertyChanged implementation. More...

void	updateEffectQuadPadding ()
	Update NodeEffect2D effect quad padding based on the current parameters. More...

Protected Member Functions inherited from kanzi::NodeEffect2D
	NodeEffect2D (Domain *domain, string_view name)
	Constructor. More...

void	setAlphaRequired (bool required)
	Sets the framebuffer alpha channel requirements of the effect. More...

void	setEffectQuadPadding (float left, float right, float top, float bottom)
	Sets the padding required by the effect around the node bounds during the rendering of the effect. More...

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadOverride ()

	Resource (Domain *domain, string_view name)
	Constructor. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage. More...

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers. More...

Protected Attributes
float	m_radius
	Cached radius for the blur effect. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Detailed Description

Use BlurEffect2D to apply a Gaussian blur post-processing effect to 2D nodes.

Examples

To create a blur effect:

    // Create an effect template for the BlurEffect2D effect prefab.
    NodeEffectTemplate2DSharedPtr blurEffectTemplate =
        NodeEffectTemplate2D::create(BlurEffect2D::getStaticMetaclass()->getName(), "BlurEffect");
    // Create a node effect prefab from the effect template.
    NodeEffectPrefab2DSharedPtr blurEffectPrefab =
        NodeEffectPrefab2D::create(getDomain(), "BlurEffect prefab", blurEffectTemplate);

To set the blur effect properties:

    // Create a blur effect template.
    NodeEffectTemplate2DSharedPtr blurEffectTemplate =
        NodeEffectTemplate2D::create(BlurEffect2D::getStaticMetaclass()->getName(), "BlurEffect");
    // Set the value of the RadiusProperty in the blur effect template.
    // RadiusProperty defines the amount of blur.
    blurEffectTemplate->addPropertyValue(BlurEffect2D::RadiusProperty, Variant(6.f));
    // Create a blur effect prefab.
    NodeEffectPrefab2DSharedPtr blurEffectPrefab =
        NodeEffectPrefab2D::create(getDomain(), "BlurEffect prefab", blurEffectTemplate);
    // Assign the blur effect to a 2D node.
    node2d->setEffectPrefab(blurEffectPrefab);
    // Get the node-specific effect instance created from the assigned prefab.
    BlurEffect2DSharedPtr blurEffect = dynamic_pointer_cast<BlurEffect2D>(node2d->getEffect());
    // Set the MaskedProperty to true. Masked mode maintains the original alpha channel and 
    // prevents the blur from spreading to fully transparent pixels.
    blurEffect->setMasked(true);

See also: NodeEffect2D, NodeEffectPrefab2D, NodeEffectTemplate2D

Since: Kanzi 3.9.0

Member Enumeration Documentation

enum kanzi::BlurEffect2D::Quality

strong

Defines the visual quality levels of the blur effect.

Enumerator
Low	Lowest blur quality.
Normal	Normal blur quality. This is the default.
High	High blur quality.
Count	Number of quality options.

Constructor & Destructor Documentation

kanzi::BlurEffect2D::BlurEffect2D	(	Domain *	domain,
		string_view	name
	)

explicitprotected

Constructor.

Parameters

domain	Domain to use.
name	Resource name.

Member Function Documentation

float kanzi::BlurEffect2D::getRadius ( ) const

inline

Gets the value of RadiusProperty.

See also: setBlurRadius()

void kanzi::BlurEffect2D::setRadius ( float value )

inline

Sets the value of RadiusProperty.

See also: getRadius()

Quality kanzi::BlurEffect2D::getQuality ( ) const

inline

Gets the value of QualityProperty.

See also: setQuality()

void kanzi::BlurEffect2D::setQuality ( Quality value )

inline

Sets the value of QualityProperty.

See also: getQuality()

bool kanzi::BlurEffect2D::getMasked ( ) const

inline

Gets the value of MaskedProperty.

See also: setMasked()

void kanzi::BlurEffect2D::setMasked ( bool value )

inline

Sets the value of MaskedProperty.

See also: getMasked()

static PropertyTypeEditorInfoSharedPtr kanzi::BlurEffect2D::makeEditorInfo ( )

static

static BlurEffect2DSharedPtr kanzi::BlurEffect2D::create	(	Domain *	domain,
		string_view	name
	)

static

Creates a blur effect.

Parameters

domain	Domain to use.
name	Resource name.

Returns: Shared pointer to the created BlurEffect2D instance.

NodeEffectRenderer2DUniquePtr kanzi::BlurEffect2D::createRendererOverride ( )

overrideprotectedvirtual

NodeEffect2D::createRendererOverride implementation.

Implements kanzi::NodeEffect2D.

void kanzi::BlurEffect2D::initializeRendererOverride ( )

overrideprotectedvirtual

NodeEffect2D::initializeRendererOverride implementation.

Implements kanzi::NodeEffect2D.

bool kanzi::BlurEffect2D::isRenderingRequiredOverride ( )

overrideprotectedvirtual

NodeEffect2D::isRenderingRequiredOverride() implementation.

Reimplemented from kanzi::NodeEffect2D.

void kanzi::BlurEffect2D::onPropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason
	)

overrideprotectedvirtual

PropertyObject::onPropertyChanged implementation.

Reimplemented from kanzi::PropertyObject.

void kanzi::BlurEffect2D::updateEffectQuadPadding ( )

protected

Update NodeEffect2D effect quad padding based on the current parameters.

Member Data Documentation

PropertyType<float> kanzi::BlurEffect2D::RadiusProperty

static

Sets the amount of blur by defining the radius of the circular area of pixels that blend into each other.

The blur radius determines the distance in pixels that the blur expands the render area by extending outward from an edge, unless you set the MaskedProperty to true. To disable the blur effect, set to 0. The default value is 8.

See also: setRadius(), getRadius()

PropertyType<Quality> kanzi::BlurEffect2D::QualityProperty

static

Sets the visual quality of the blur effect.

Lower quality uses less computing and memory resources. The default value is Normal.

See also: setQuality(), getQuality()

PropertyType<bool> kanzi::BlurEffect2D::MaskedProperty

static

Sets whether to blur only pixels with non-zero alpha values.

When enabled the blur does not spread to fully transparent pixels and the edges of the content stay sharp. The default value is false.

See also: setMasked(), getMasked()

float kanzi::BlurEffect2D::m_radius

protected

Cached radius for the blur effect.

Kanzi uses this to determine whether the effect is renderable.

The documentation for this class was generated from the following file:

kanzi/core.ui/effect/blur_effect2d.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Examples

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation